home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 1 / LIGHT-ROM 1 (Amiga Library Services)(1994).iso / ffdisks / d913.lha / StickIt / StickIt.doc < prev    next >
Text File  |  1993-10-03  |  13KB  |  353 lines
  1. StickIt - Version 1.02 (written 12th April '93)
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. Copyright 1993 Andy Dean, all rights reserved
  4. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5.    Permission is granted to make and distribute verbatim copies of 
  6. this manual provided the copyright notice and this permission notice 
  7. are preserved on all copies.
  8.  
  9.    No guarantee of any kind is given that the programs described in 
  10. this document are 100% reliable. You are using this material at your 
  11. own risk. The author *can not* be made responsible for any damage 
  12. which is caused by using these programs.
  13.  
  14.    This package is freely distributable, but still copyright by Andy 
  15. Dean. This means that you can copy it freely as long as you don't ask 
  16. for a more than nominal copying fee.
  17.  
  18.    Permission is granted to include this package in Public-Domain 
  19. collections, especially in the excellent Fred Fish Amiga Disk Library 
  20. (including CD ROM versions of it). The distribution file may be 
  21. uploaded to Bulletin Board Systems or FTP servers. If you want to 
  22. distribute this program you must use the original distribution archive 
  23. "StickIt-1.02.lha".
  24.  
  25.    None of the programs nor the source code (nor parts of it) may be
  26. included or used in commercial programs unless by written permission
  27. from the author.
  28.  
  29. Requirements
  30. ~~~~~~~~~~~~
  31.     o    AmigaDos 2.04+
  32.  
  33. What Is StickIt ?
  34. ~~~~~~~~~~~~~~~~~
  35.     StickIt is a computer replacement for the ol' Post-It note. It 
  36. allows you to stick notes onto your screen which will be displayed 
  37. every time you re-boot; useful to remind you of things to do.
  38.  
  39. Features
  40. ~~~~~~~~
  41.     o    Unlimited number of notes on screen.
  42.     o    The notes remember where you left them.
  43.     o    User-defined font name/size.
  44.     o    User-defined note size.
  45.     o    User-defined text/background colour (yep, they can be yellow
  46.         if you want !)
  47.     o    User-defined delay at startup to avoid disk thrashing.
  48.     o    User-defined filename for note information.
  49.     o    Standard Workbench 2 interface, with keyboard shortcuts. 
  50.         Designed with the wonderful "GadToolsBox" by Jan van den
  51.          Baard.
  52.  
  53.  
  54. Why Did I Write StickIt ?
  55. ~~~~~~~~~~~~~~~~~~~~~~~~~
  56.     StickIt was written with a job to do... to replace all the bits 
  57. of paper I used to leave around to remind me to do something. I have 
  58. tried to write a program to do that with the minimum of fuss and with 
  59. a nice clean Workbench 2 interface. I have tried to make the program 
  60. configurable enough for each user's needs, without over-doing it. 
  61. There was no such utility available in the Public Domain at the time. 
  62. Recently NoteIt! written by Ryan J. Bruner has appeared which has 
  63. prompted me to actually finish the documentation and release StickIt.
  64.  
  65. How Do I Use StickIt ?
  66. ~~~~~~~~~~~~~~~~~~~~~~
  67.     Just double-click on the icon!
  68.  
  69.     The program will always needs a note file to run, and by default 
  70. this is called "StickIt.notes" and is located in the current 
  71. directory. Use the tooltypes in the program icon to configure the 
  72. program for your use.
  73.  
  74. Theory of Operation
  75. ~~~~~~~~~~~~~~~~~~~
  76.     StickIt has 2 modes of operation. EITHER it is showing the notes 
  77. on the screen OR it is showing the edit window to allow the user to 
  78. alter the information kept in the notes.
  79.  
  80. Showing the Notes
  81. -----------------
  82.     When the notes are being displayed, the user may position each 
  83. note by dragging the note with the drag bar. The position of the note 
  84. will be stored when the note file is saved.
  85.  
  86.     A note can be temporarily hidden from view by double-clicking on 
  87. the note (not on the drag bar) or typing "h" while the note is active.
  88. The note will remain hidden for the current session, unless the user
  89. makes the note visable again by using "Show" in the edit window (see
  90. later). This information is not saved, as all notes are shown when
  91. StickIt is run.
  92.  
  93.     The edit window can be brought up to edit the notes by clicking 
  94. with the right mouse button or typing "e" on the active note. This note
  95. will be the current note in the edit window.
  96.  
  97.     The current note can be pushed behind other windows by either
  98. using the depth gadget, or typing "b". The current note can be
  99. brought infront of other windows by either using the depth gadget,
  100. or typing "f".
  101.  
  102.     All actions to do with the saving of the note file, quitting of 
  103. the program, adding and deleting notes must be done from the edit 
  104. window.
  105.  
  106. The Edit Window
  107. ---------------
  108.     The window is brought up by clicking with the right mouse button 
  109. on the active note. It is also brought up if an attempt is made to 
  110. make all the current notes hidden, or the StickIt is run with the 
  111. STARTEDIT=YES tooltype, or there are no notes in the note file.
  112.  
  113.     Adding a new note:
  114.  
  115.     This is done by clicking on the "Add" gadget or pressing "a". The 
  116. "Note " and "Title" fields are cleared and your cursor is placed in 
  117. the "Title" field. The "Title" field contains the text that will 
  118. appear in the note's drag bar. Pressing <TAB> will move your cursor to 
  119. the "Note" field. Here you can type the main text that will appear in 
  120. the body of the note. Pressing <TAB> will move your cursor back to the 
  121. "Title" field. As with version 1.02, <RETURN> will also cycle between the
  122. "Note" and "Title" fields.
  123.  
  124.     When you are happy with the text, click on the "Add" gadget again 
  125. and the note will be added to the list. The new note will be added to 
  126. the front of the list and will be drawn last, and so will be infront 
  127. if any notes overlap it.
  128.  
  129.     Deleting the current note:
  130.  
  131.     The current note is that one which is currently on display in the 
  132. edit window. Selecting "Delete" from the "Edit" menu (keyboard 
  133. shortcut = RIGHT AMIGA + B) will remove this note from the list.
  134.  
  135.     Cut, copy, paste:
  136.  
  137.     You may cut (keyboard shortcut = RIGHT AMIGA + X), copy (keyboard 
  138. shortcut = RIGHT AMIGA + C) and paste (keyboard shortcut = RIGHT AMIGA 
  139. + V) notes using the "Edit" menu. This is useful to re-arrange the 
  140. order in which notes are drawn or create multiple similar notes from 
  141. one existing note. StickIt uses its own internal clipboard, not the 
  142. Amiga's. You can't cut/copy/paste information between applications 
  143. (sorry!).
  144.  
  145.     Editing the current note:
  146.  
  147.     To change the information in the current note, simply alter the 
  148. text in the "Title" and "Note" text fields. Instead of just clicking 
  149. in the text gadgets, keyboard shortcuts "t" and "n" have been 
  150. provided.
  151.  
  152.     Hiding the current note:
  153.  
  154.     All notes by default are visable when StickIt is run. By clicking 
  155. on the "Show" gadget (keyboard shortcut = "s"), the note can be hidden 
  156. from view - useful to stop notes that you've acknowledged from 
  157. cluttering up your screen.
  158.  
  159.     Changing the current note:
  160.  
  161.     The current note can be changed by using the back and forth 
  162. gadgets at the bottom of the edit window (keyboard shortcuts = "<" or 
  163. "," and ">" or "."). The front and back of the list can also be 
  164. reached with the "Front" and "Back" gadgets (keyboard shortcuts = "f" 
  165. and "b").
  166.  
  167.     Showing all notes:
  168.  
  169.     You can see the effects of your edits by selecting "Show 
  170. notes..." (keyboard shortcut = RIGHT AMIGA + N) from the "Edit" 
  171. window. Return to the edit window by clicking right mouse button on an 
  172. active note. Alternatively press click on the "Notes..." gadget in the edit window.
  173.  
  174.     Saving the current note file:
  175.  
  176.     Choose "Save" (keyboard shortcut = RIGHT AMIGA + S) from the 
  177. "Project" menu to save the current notes to the note file.
  178.  
  179.     Opening the current note file:
  180.  
  181.     Choose "Open" (keyboard shortcut = RIGHT AMIGA + O) from the 
  182. "Project" menu to open the current note file, replacing the current 
  183. notes with those of the note file. You will be warned if the current 
  184. notes have been changed.
  185.  
  186. Other menu items...
  187. -------------------
  188.     About
  189.  
  190.      Cute about window. Click on the window to make it go away.
  191.  
  192.     Quit
  193.  
  194.     Will quit the program. Will warn you if the notes have been 
  195. changed.
  196.  
  197.  
  198. Configuring StickIt
  199. ~~~~~~~~~~~~~~~~~~~
  200.     StickIt is entirely configured from the icon's tooltypes. Any 
  201. tooltype enclosed in parenthesis is commented out, causing the default 
  202. value to be used.
  203.  
  204. NOTEFILE=<filename>        Default:StickIt.notes
  205.  
  206.     This gives the filename of the file that will used to store the 
  207. note information. The default file is "StickIt.notes" in the current 
  208. directory. Other possibilities could be:
  209.  
  210.     NOTEFILE=s:StickIt.notes
  211.     NOTEFILE=ENVARC:StickIt.notes
  212.  
  213. FONTNAME=<fontname>.font        Default:Helvetica
  214.  
  215.     This is the name of the font used to write the text in the notes. 
  216. If no font name is given, StickIt tries to open Times font. Failing 
  217. that, the default screen font is used. My personal favourite font is 
  218. "junod" given away with Commodore's "AmigaGuide" distribution (if you 
  219. don't have AmigaGuide - WHY NOT!?!). Failing that, a nice handwriting 
  220. font may look good, anyway I digress...
  221.  
  222. Note: You must always put a ".font" postfix after the name of the 
  223. font, otherwise StickIt will not find the font (eg `Times.font' or 
  224. `junod.font').
  225.  
  226. FONTSIZE=<number>        Default:12
  227.  
  228.     This is the size in points of the font.
  229.  
  230. NOTEHEIGHT=<number>        Default:70
  231.  
  232.     The height of each note in pixels.
  233.  
  234. NOTEWIDTH=<number>        Default:150
  235.  
  236.     The width of each note in pixels.
  237.  
  238. TEXTCOLOUR=<number>        Default:1 (Black)
  239.  
  240.     The number of the colour of the pen used to print the main text 
  241. of the note. Note the English spelling of "colour".
  242.  
  243. BACKCOLOUR=<number>        Default:0 (Grey)
  244.  
  245.     The number of the colour of the pen used as the background of the 
  246. note. Users with >4 colours may wish to make this value that of a 
  247. pastel yellow, to give the "look and feel" of a real PostIt note. Note 
  248. the English spelling of "colour".
  249.  
  250. DELAY=<number>            Default:0
  251.  
  252.     This is a delay in seconds before the note file is loaded. This 
  253. is useful if StickIt is placed in the WBStartup drawer with other 
  254. applications loaded at startup. If this value is set to a few seconds, 
  255. then StickIt will not be competing for the drive at the same time as 
  256. Workbench is loading applictions.
  257.  
  258. STARTEDIT=<YES> or <NO>        Default:NO
  259.  
  260.     Normally StickIt will start by displaying all notes present in 
  261. the note file. If no notes are present, the edit window is opened 
  262. instead. By setting STARTEDIT to YES, you can force StickIt to open 
  263. the edit window even if there notes in the notefile.
  264.  
  265. DONOTWAIT
  266.  
  267.     Standard WBStartup command to tell Workbench not to wait for 
  268. StickIt to finish executing before continuing with the startup.
  269.  
  270. Creating An Empty Note File
  271. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  272.  
  273.     StickIt requires a note file to operate; StickIt will terminate 
  274. with an error if the note file can't be found. In order to create a 
  275. blank file, I have provided an ARexx utility to do this. If you wish 
  276. to create a blank file called "s:StickIt.note" then simply 
  277. double-click on the "CreateEmptyFile.rexx" icon and type 
  278. "s:StickIt.note" as the filename. Then change the tooltypes of StickIt 
  279. to read "NOTEFILE=s:StickIt.notes".
  280.  
  281.     Note that you need ARexx running for this to work.
  282.  
  283. Thanks...
  284. ~~~~~~~~~
  285.  
  286.     o Commodore for the Amiga. More programming utilities and 
  287. information is needed from C=. AmigaGuide and the ROM Kernal Reference 
  288. manuals are a start, but can we also have a window designer, the 3.0 
  289. includes and information about new system routines. Wishful thinking?
  290.     o Fred Fish for his EXCELLENT library, I just hope that he can 
  291. continue to get the support in order to run the library.
  292.     o The organisers of Aminet. Thanks for a well organised service 
  293. for us lucky souls with anonymous ftp access.
  294.     o All the shareware / public domain / freeware authors for tons 
  295. of excellent software.
  296.  
  297. Tested On...
  298. ~~~~~~~~~~~~
  299.  
  300.     StickIt has been tested on:
  301.  
  302.     o Amiga 500 with
  303.         1M Chip RAM
  304.         2M Fast RAM
  305.         Workbench 2.04
  306.         Commodore A590 hard drive, 85M Connor SCSI drive
  307.         Microbotics VXL30 accellerator
  308.  
  309.     o Amiga 1200 with
  310.         2M Chip RAM
  311.         60M internal hard drive
  312.         External floppy
  313.  
  314.  
  315. Limitations
  316. ~~~~~~~~~~~
  317.     o    All data is stored in a linked list and so there is no limit 
  318. to the number of notes available for use.
  319.     o    29 characters can be used in the `Title' field.
  320.     o    255 characters can be used in the `Note' field.
  321.  
  322. Improvements
  323. ~~~~~~~~~~~~
  324.     I have no real intention to continue improving the program, I 
  325. have been using the program myself for a while now and can find 
  326. no bugs in it and it does the job for which it was intended. Besides, 
  327. inbetween writing StickIt I have a PhD to be getting on with :) , 
  328. HOWEVER if you do find a nasty bug then let me know and I'll do my 
  329. best...
  330.  
  331. My Address...
  332. ~~~~~~~~~~~~~
  333.  
  334.     Andy Dean
  335.     Electronic Engineering Dept.
  336.     University College London
  337.     Torrington Place
  338.     London
  339.     WC1E 7JE
  340.     England
  341.  
  342.     Email: adean@eleceng.ucl.ac.uk
  343.  
  344. And finally...
  345. ~~~~~~~~~~~~~~
  346.  
  347.     If you use and enjoy this software then send me a postcard to 
  348. tell me how far StickIt has reached. Go on, it'll only take a few 
  349. minutes...
  350.  
  351.  
  352.     Ta very much,    Andy Dean
  353.